compress-commons

What is compress-commons?

The compress-commons npm package is a library that provides a set of reusable classes and functions for creating and extracting archive files. It supports various archive formats, making it a versatile tool for handling compression and decompression tasks in Node.js applications.

What are compress-commons's main functionalities?

Creating Archive Files

This feature allows you to create archive files. The code sample demonstrates how to create a TAR archive containing a single file with the content 'Hello World!'.

const fs = require('fs');
const tar = require('compress-commons').tar;
const output = fs.createWriteStream('archive.tar');
const archive = tar.createArchiveStream();
output.on('close', function() {
  console.log('Archive has been finalized.');
});
archive.pipe(output);
archive.entry('file.txt', 'Hello World!', function(err) {
  if (err) throw err;
  archive.finish();
});

Extracting Archive Files

This feature enables the extraction of archive files. The provided code sample shows how to extract files from a TAR archive, handling each entry and completing the process.

const fs = require('fs');
const tar = require('compress-commons').tar;
const input = fs.createReadStream('archive.tar');
const archive = tar.extractArchiveStream();
input.pipe(archive);
archive.on('entry', function(header, stream, next) {
  stream.on('end', next);
  stream.resume();
});
archive.on('finish', function() {
  console.log('Extraction complete.');
});

Other packages similar to compress-commons

archiver

Archiver is a popular npm package for file archiving. It supports creating and streaming archives in formats like ZIP and TAR. Compared to compress-commons, Archiver offers a high-level API that might be easier to use for common archiving tasks.

extract-zip

extract-zip is focused solely on extracting ZIP files. It provides a simpler interface for this specific task, making it less versatile but potentially more straightforward to use for ZIP extraction compared to the broader scope of compress-commons.

yauzl

yauzl is another npm package for reading and extracting ZIP files. It offers a low-level interface for ZIP file manipulation, providing more control but requiring more code for common tasks compared to compress-commons, which offers a more balanced approach between ease of use and control.

README

Compress Commons v1.2.1

Compress Commons is a library that defines a common interface for working with archive formats within node.

Install

npm install compress-commons --save

You can also use npm install https://github.com/archiverjs/node-compress-commons/archive/master.tar.gz to test upcoming versions.

Things of Interest

• Changelog
• Contributing
• MIT License

Credits

Concept inspired by Apache Commons Compress™.

Some logic derived from Apache Commons Compress™ and OpenJDK 7.